<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    public interface TravelAgent {<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>        /**<a name="line.5"></a>
<FONT color="green">006</FONT>         * Set the Block radius to search in for available portals.<a name="line.6"></a>
<FONT color="green">007</FONT>         *<a name="line.7"></a>
<FONT color="green">008</FONT>         * @param radius The radius in which to search for a portal from the location.<a name="line.8"></a>
<FONT color="green">009</FONT>         * @return<a name="line.9"></a>
<FONT color="green">010</FONT>         */<a name="line.10"></a>
<FONT color="green">011</FONT>        public TravelAgent setSearchRadius(int radius);<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>        /**<a name="line.13"></a>
<FONT color="green">014</FONT>         * Gets the search radius value for finding an available portal.<a name="line.14"></a>
<FONT color="green">015</FONT>         *<a name="line.15"></a>
<FONT color="green">016</FONT>         * @return Returns the currently set search radius.<a name="line.16"></a>
<FONT color="green">017</FONT>         */<a name="line.17"></a>
<FONT color="green">018</FONT>        public int getSearchRadius();<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>        /**<a name="line.20"></a>
<FONT color="green">021</FONT>         * Sets the maximum radius from the given location to create a portal.<a name="line.21"></a>
<FONT color="green">022</FONT>         *<a name="line.22"></a>
<FONT color="green">023</FONT>         * @param radius The radius in which to create a portal from the location.<a name="line.23"></a>
<FONT color="green">024</FONT>         * @return<a name="line.24"></a>
<FONT color="green">025</FONT>         */<a name="line.25"></a>
<FONT color="green">026</FONT>        public TravelAgent setCreationRadius(int radius);<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>        /**<a name="line.28"></a>
<FONT color="green">029</FONT>         * Gets the maximum radius from the given location to create a portal.<a name="line.29"></a>
<FONT color="green">030</FONT>         *<a name="line.30"></a>
<FONT color="green">031</FONT>         * @return Returns the currently set creation radius.<a name="line.31"></a>
<FONT color="green">032</FONT>         */<a name="line.32"></a>
<FONT color="green">033</FONT>        public int getCreationRadius();<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>        /**<a name="line.35"></a>
<FONT color="green">036</FONT>         * Returns whether the TravelAgent will attempt to create a destination portal or not.<a name="line.36"></a>
<FONT color="green">037</FONT>         *<a name="line.37"></a>
<FONT color="green">038</FONT>         * @return Return whether the TravelAgent should create a destination portal or not.<a name="line.38"></a>
<FONT color="green">039</FONT>         */<a name="line.39"></a>
<FONT color="green">040</FONT>        public boolean getCanCreatePortal();<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>        /**<a name="line.42"></a>
<FONT color="green">043</FONT>         * Sets whether the TravelAgent should attempt to create a destination portal or not.<a name="line.43"></a>
<FONT color="green">044</FONT>         *<a name="line.44"></a>
<FONT color="green">045</FONT>         * @param create Sets whether the TravelAgent should create a destination portal or not.<a name="line.45"></a>
<FONT color="green">046</FONT>         */<a name="line.46"></a>
<FONT color="green">047</FONT>        public void setCanCreatePortal(boolean create);<a name="line.47"></a>
<FONT color="green">048</FONT>    <a name="line.48"></a>
<FONT color="green">049</FONT>        /**<a name="line.49"></a>
<FONT color="green">050</FONT>         * Attempt to find a portal near the given location, if a portal is not found it will attempt to create one.<a name="line.50"></a>
<FONT color="green">051</FONT>         *<a name="line.51"></a>
<FONT color="green">052</FONT>         * @param location The location where the search for a portal should begin.<a name="line.52"></a>
<FONT color="green">053</FONT>         * @return Returns the location of a portal which has been found or returns the location passed to the method if unsuccessful.<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        public Location findOrCreate(Location location);<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>        /**<a name="line.57"></a>
<FONT color="green">058</FONT>         * Attempt to find a portal near the given location.<a name="line.58"></a>
<FONT color="green">059</FONT>         *<a name="line.59"></a>
<FONT color="green">060</FONT>         * @return Returns the location of the nearest portal to the location.<a name="line.60"></a>
<FONT color="green">061</FONT>         */<a name="line.61"></a>
<FONT color="green">062</FONT>        public Location findPortal(Location location);<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>        /**<a name="line.64"></a>
<FONT color="green">065</FONT>         * Attempt to create a portal near the given location.<a name="line.65"></a>
<FONT color="green">066</FONT>         *<a name="line.66"></a>
<FONT color="green">067</FONT>         * @return True if a nether portal was successfully created.<a name="line.67"></a>
<FONT color="green">068</FONT>         */<a name="line.68"></a>
<FONT color="green">069</FONT>        public boolean createPortal(Location location);<a name="line.69"></a>
<FONT color="green">070</FONT>    }<a name="line.70"></a>




























































</PRE>
</BODY>
</HTML>
